<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ShellContactSystem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Shell Reference Manual">
<link rel="up" href="ch03.html" title="Search">
<link rel="prev" href="ShellAppSystem.html" title="ShellAppSystem">
<link rel="next" href="ch04.html" title="Tray Icons">
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ShellAppSystem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Shell Reference Manual</th>
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ShellContactSystem.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ShellContactSystem.description" class="shortcut">Description</a>
                   | 
                  <a href="#ShellContactSystem.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="ShellContactSystem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ShellContactSystem.top_of_page"></a>ShellContactSystem</span></h2>
<p>ShellContactSystem</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ShellContactSystem.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="ShellContactSystem.html#ShellContactSystem-struct" title="struct ShellContactSystem">ShellContactSystem</a>;
struct              <a class="link" href="ShellContactSystem.html#ShellContactSystemClass" title="struct ShellContactSystemClass">ShellContactSystemClass</a>;
<span class="returnvalue">GeeMap</span> *            <a class="link" href="ShellContactSystem.html#shell-contact-system-get-all" title="shell_contact_system_get_all ()">shell_contact_system_get_all</a>        (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *self</code></em>);
<a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="returnvalue">ShellContactSystem</span></a> * <a class="link" href="ShellContactSystem.html#shell-contact-system-get-default" title="shell_contact_system_get_default ()">shell_contact_system_get_default</a>   (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">char</span> *              <a class="link" href="ShellContactSystem.html#shell-contact-system-get-email-for-display" title="shell_contact_system_get_email_for_display ()">shell_contact_system_get_email_for_display</a>
                                                        (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">FolksIndividual</span> *individual</code></em>);
<span class="returnvalue">FolksIndividual</span> *   <a class="link" href="ShellContactSystem.html#shell-contact-system-get-individual" title="shell_contact_system_get_individual ()">shell_contact_system_get_individual</a> (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *id</code></em>);
<span class="returnvalue">GSList</span> *            <a class="link" href="ShellContactSystem.html#shell-contact-system-initial-search" title="shell_contact_system_initial_search ()">shell_contact_system_initial_search</a> (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *shell</code></em>,
                                                         <em class="parameter"><code><span class="type">GSList</span> *terms</code></em>);
<span class="returnvalue">GSList</span> *            <a class="link" href="ShellContactSystem.html#shell-contact-system-subsearch" title="shell_contact_system_subsearch ()">shell_contact_system_subsearch</a>      (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *shell</code></em>,
                                                         <em class="parameter"><code><span class="type">GSList</span> *previous_results</code></em>,
                                                         <em class="parameter"><code><span class="type">GSList</span> *terms</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ShellContactSystem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----ShellContactSystem
</pre>
</div>
<div class="refsect1">
<a name="ShellContactSystem.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="ShellContactSystem.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ShellContactSystem-struct"></a><h3>struct ShellContactSystem</h3>
<pre class="programlisting">struct ShellContactSystem;</pre>
</div>
<hr>
<div class="refsect2">
<a name="ShellContactSystemClass"></a><h3>struct ShellContactSystemClass</h3>
<pre class="programlisting">struct ShellContactSystemClass {
  GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="shell-contact-system-get-all"></a><h3>shell_contact_system_get_all ()</h3>
<pre class="programlisting"><span class="returnvalue">GeeMap</span> *            shell_contact_system_get_all        (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *self</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>A <a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>All individuals. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="shell-contact-system-get-default"></a><h3>shell_contact_system_get_default ()</h3>
<pre class="programlisting"><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="returnvalue">ShellContactSystem</span></a> * shell_contact_system_get_default   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The global <a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> singleton. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="shell-contact-system-get-email-for-display"></a><h3>shell_contact_system_get_email_for_display ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              shell_contact_system_get_email_for_display
                                                        (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">FolksIndividual</span> *individual</code></em>);</pre>
<p>
Get an email address (either from IM addresses or email), which can be
used to represent <em class="parameter"><code>individual</code></em>.
</p>
<p>
Return: (transfer full): a newly allocated string or <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if no address
                         was found
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>A <a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a>
<em class="parameter"><code>individual</code></em> A <span class="type">FolksIndividual</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="shell-contact-system-get-individual"></a><h3>shell_contact_system_get_individual ()</h3>
<pre class="programlisting"><span class="returnvalue">FolksIndividual</span> *   shell_contact_system_get_individual (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> *id</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>A <a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>A <span class="type">gchar</span> with the ID of the FolksIndividual to be returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <span class="type">FolksIndividual</span> or NULL if <em class="parameter"><code>id</code></em> could not be found. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="shell-contact-system-initial-search"></a><h3>shell_contact_system_initial_search ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *            shell_contact_system_initial_search (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *shell</code></em>,
                                                         <em class="parameter"><code><span class="type">GSList</span> *terms</code></em>);</pre>
<p>
Search through contacts for the given search terms.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>A <a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>terms</code></em> :</span></p></td>
<td>List of terms, logical AND. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>List of contact
identifiers. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="shell-contact-system-subsearch"></a><h3>shell_contact_system_subsearch ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *            shell_contact_system_subsearch      (<em class="parameter"><code><a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a> *shell</code></em>,
                                                         <em class="parameter"><code><span class="type">GSList</span> *previous_results</code></em>,
                                                         <em class="parameter"><code><span class="type">GSList</span> *terms</code></em>);</pre>
<p>
Search through a previous result set; for more information see
js/ui/search.js.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>A <a class="link" href="ShellContactSystem.html" title="ShellContactSystem"><span class="type">ShellContactSystem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>previous_results</code></em> :</span></p></td>
<td>List of previous results. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>terms</code></em> :</span></p></td>
<td>List of terms, logical AND. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>List of contact
identifiers. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18.1</div>
</body>
</html>